Conversation
Adds a Claude-based deep research workflow definition scaffold, trigger example, and docs with web-search/web-fetch enabled. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughAdds a new "Deep Research" assistant: documentation, an example trigger workflow, a workflow-call markdown, a comprehensive locked GitHub Actions implementation with Safe Inputs/Outputs and MCP gateways, and an auto-generated trigger workflow activated by issue comments starting with "/research". (50 words) Changes
Sequence Diagram(s)sequenceDiagram
participant User as Issue Commenter
participant GH as GitHub Events
participant Runner as Actions Runner
participant Agent as Gemini Agent
participant Safe as SafeOutputs/SafeInputs MCP
participant Repo as Repository (Issues/PRs)
User->>GH: posts comment "/research"
GH->>Runner: trigger workflow (trigger-deep-research.yml)
Runner->>Runner: activation job (context, checkout, aw_info)
Runner->>Agent: start agent job (invoke Gemini with tools)
Agent->>Safe: request validated actions via MCP (add_comment, create_pr, etc.)
Safe-->>Agent: validated outputs / permitted actions
Agent->>Repo: post comment or open PR via SafeOutputs
Runner->>Runner: detection, logging, artifact upload
Estimated code review effort🎯 4 (Complex) | ⏱️ ~45 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches
🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Verdict: APPROVE. I found no new actionable issues in the current diff.
What is this? | From workflow: PR Review
Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.
|
/ai it should not make a PR, it should just comment on the issue. The prompt needs to provide instructions relevant to deep research, i.e. perform web searches and catalogue information and produce an analysis |
|
Implemented your requested behavior change and pushed a follow-up commit to the PR branch. What changed
Files updated
Validation
What is this? | From workflow: Mention in PR Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not. |
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.github/workflows/gh-aw-deep-research.md:
- Around line 130-133: Update Step 4 to remove any mention of opening a PR via
`create_pull_request`; edit the text under "Step 4: Execute (if applicable)" so
it only instructs making minimal changes locally (if implementation is
requested), running required validations, and producing a research-focused
report or deliverables rather than creating a pull request; ensure the phrase
`create_pull_request` is deleted and the step emphasizes validation and
presentation of findings.
- Around line 98-101: The workflow claims the agent can "create pull requests"
but must only post comments; remove "create pull requests" from the CAN list and
update the following guidance sentence "When creating pull requests, make the
changes in the workspace first, then use `create_pull_request`." to instead
instruct only to prepare changes locally and post comments (or propose changes
via comments) — ensure you remove any mention of the `create_pull_request`
capability and any instructions referencing it, leaving the "CAN" / "CANNOT"
constraints and the guidance to only post comments.
- Around line 43-47: Remove the unnecessary workflow input named "draft-prs" by
deleting its input definition block (the draft-prs input with
description/type/required/default) from the workflow inputs and also remove any
references to "draft-prs" in the workflow (e.g., places that read
inputs.draft-prs or pass it to actions) so the workflow no longer attempts to
create PRs; focus on the input identifier "draft-prs" to locate and remove both
its declaration and any usages.
- Line 4: The workflow description still advertises "optional PR creation" and
the workflow imports the fragment safe-output-create-pr.md, which conflicts with
the PR objective of not creating PRs; update the description string to remove
any mention of PR creation (e.g., change "Deep research assistant for issue
comments with web fetch/search and optional PR creation" to omit PR creation)
and remove the import/usage of safe-output-create-pr.md as well as any
steps/outputs that invoke create-pr logic (search for references to
safe-output-create-pr, create-pr, or POST /pulls in the workflow and delete or
replace them so the workflow only posts issue comments).
---
Duplicate comments:
In @.github/workflows/gh-aw-deep-research.md:
- Around line 58-61: The workflow's permissions block currently sets "issues:
read" which prevents the workflow from posting comments or creating issues;
update the permissions mapping so that the "issues" permission is set to "write"
(i.e., change the "issues: read" entry to "issues: write") so the workflow can
post issue comments and create issues while keeping other permissions as
intended.
There was a problem hiding this comment.
Verdict: APPROVE. I left one low-priority documentation accuracy comment.
What is this? | From workflow: PR Review
Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.
| - [Code Duplication Fixer](code-duplication-fixer/) — fix code-duplication-detector issues | ||
|
|
||
| **Research assistants**: | ||
| - [Deep Research](deep-research/) — issue-comment deep research with web search/fetch and optional PR creation |
There was a problem hiding this comment.
[LOW] Deep Research description no longer matches workflow capabilities
This index entry says Deep Research supports "web search/fetch and optional PR creation", but the workflow introduced in this PR is read-only and only documents web-fetch plus add-comment output (.github/workflows/gh-aw-deep-research.md, gh-agent-workflows/deep-research/README.md). Keeping this line inaccurate will mislead adopters about available tools and outputs; please align the wording with the actual behavior.
There was a problem hiding this comment.
Verdict: APPROVE.
What is this? | From workflow: PR Review
Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.
| | --- | --- | --- | --- | | ||
| | `additional-instructions` | Repo-specific instructions appended to the agent prompt | No | `""` | | ||
| | `allowed-bot-users` | Allowlisted bot actor usernames (comma-separated) | No | `github-actions[bot]` | | ||
|
|
There was a problem hiding this comment.
[LOW] Documented inputs omit setup-commands supported by the workflow
The workflow definition includes a setup-commands input (.github/workflows/gh-aw-deep-research.md lines 31-35), but this README’s Inputs table only lists additional-instructions and allowed-bot-users. That mismatch can cause users to miss a supported configuration option when installing the workflow.
Please add a setup-commands row to keep the docs aligned with the workflow contract.
Summary
.github/workflows/gh-aw-deep-research.md..github/workflows/gh-aw-deep-research.lock.ymland.github/workflows/trigger-deep-research.yml.gh-agent-workflows/deep-research/.gh-agent-workflows/README.md.Behavior
issue_comment(created) events only, with trigger filtering to issue comments (not PR comments) that start with/research.gemini-3-pro-previewby default) withweb-fetchenabled.Configuration
model,additional-instructions,setup-commands,allowed-bot-users, andmessages-footer.GEMINI_API_KEY.add-comment.Fixes #336